<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilplmi: xplmi_mailbox.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilplmi
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xplmi__mailbox_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xplmi_mailbox.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains declarations of xilmailbox generic interface APIs. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
</p>
<hr/>
<p>
1.00  dd   01/09/24 Initial release
      am   04/10/24 Fixed doxygen warning
1.01  pre  07/10/24 Added SLR index in client data structure
1.02  obs  02/18/25 Fixed IPI message length</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gae508f5560019d2dea0e123f17507e579"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__mailbox__apis.html#gae508f5560019d2dea0e123f17507e579">XILPLMI_MODULE_ID</a>&#160;&#160;&#160;(1U)</td></tr>
<tr class="memdesc:gae508f5560019d2dea0e123f17507e579"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module ID for xilplmi.  <a href="group__xilplmi__mailbox__apis.html#gae508f5560019d2dea0e123f17507e579">More...</a><br/></td></tr>
<tr class="separator:gae508f5560019d2dea0e123f17507e579"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4b6c33d928a245e03965396fdde7ceea"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__mailbox__apis.html#ga4b6c33d928a245e03965396fdde7ceea">PAYLOAD_ARG_CNT</a>&#160;&#160;&#160;XIPIPSU_MAX_MSG_LEN</td></tr>
<tr class="memdesc:ga4b6c33d928a245e03965396fdde7ceea"><td class="mdescLeft">&#160;</td><td class="mdescRight">1 for API ID + 5 for API arguments + 1 for reserved + 1 for CRC  <a href="group__xilplmi__mailbox__apis.html#ga4b6c33d928a245e03965396fdde7ceea">More...</a><br/></td></tr>
<tr class="separator:ga4b6c33d928a245e03965396fdde7ceea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaff9dc4f696e94fbe988997c3a4ba60c3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__mailbox__apis.html#gaff9dc4f696e94fbe988997c3a4ba60c3">RESPONSE_ARG_CNT</a>&#160;&#160;&#160;XIPIPSU_MAX_MSG_LEN</td></tr>
<tr class="memdesc:gaff9dc4f696e94fbe988997c3a4ba60c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">1 for status + 3 for values + 3 for reserved + 1 for CRC  <a href="group__xilplmi__mailbox__apis.html#gaff9dc4f696e94fbe988997c3a4ba60c3">More...</a><br/></td></tr>
<tr class="separator:gaff9dc4f696e94fbe988997c3a4ba60c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab7464594dd9d5a4d9e22464ba51d3f84"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__mailbox__apis.html#gab7464594dd9d5a4d9e22464ba51d3f84">XPLMI_TARGET_IPI_INT_MASK</a>&#160;&#160;&#160;(0x00000002U)</td></tr>
<tr class="memdesc:gab7464594dd9d5a4d9e22464ba51d3f84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Target PMC IPI interrupt mask.  <a href="group__xilplmi__mailbox__apis.html#gab7464594dd9d5a4d9e22464ba51d3f84">More...</a><br/></td></tr>
<tr class="separator:gab7464594dd9d5a4d9e22464ba51d3f84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaecb7af5bbddf6dfb07a41be372941684"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__mailbox__apis.html#gaecb7af5bbddf6dfb07a41be372941684">XPLMI_MODULE_ID_SHIFT</a>&#160;&#160;&#160;(8U)</td></tr>
<tr class="memdesc:gaecb7af5bbddf6dfb07a41be372941684"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module Id shift.  <a href="group__xilplmi__mailbox__apis.html#gaecb7af5bbddf6dfb07a41be372941684">More...</a><br/></td></tr>
<tr class="separator:gaecb7af5bbddf6dfb07a41be372941684"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa45a26da576e12a1f6fea17ed1f60bf1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__mailbox__apis.html#gaa45a26da576e12a1f6fea17ed1f60bf1">XPLMI_PAYLOAD_LEN_SHIFT</a>&#160;&#160;&#160;(16U)</td></tr>
<tr class="memdesc:gaa45a26da576e12a1f6fea17ed1f60bf1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Length shift mask.  <a href="group__xilplmi__mailbox__apis.html#gaa45a26da576e12a1f6fea17ed1f60bf1">More...</a><br/></td></tr>
<tr class="separator:gaa45a26da576e12a1f6fea17ed1f60bf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa1d50a58a4ebc2cdae6f35cf1d1b6ee2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__mailbox__apis.html#gaa1d50a58a4ebc2cdae6f35cf1d1b6ee2">XILPLMI_MODULE_ID_MASK</a>&#160;&#160;&#160;((u32)<a class="el" href="group__xilplmi__mailbox__apis.html#gae508f5560019d2dea0e123f17507e579">XILPLMI_MODULE_ID</a> &lt;&lt; <a class="el" href="group__xilplmi__mailbox__apis.html#gaecb7af5bbddf6dfb07a41be372941684">XPLMI_MODULE_ID_SHIFT</a>)</td></tr>
<tr class="memdesc:gaa1d50a58a4ebc2cdae6f35cf1d1b6ee2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module id mask.  <a href="group__xilplmi__mailbox__apis.html#gaa1d50a58a4ebc2cdae6f35cf1d1b6ee2">More...</a><br/></td></tr>
<tr class="separator:gaa1d50a58a4ebc2cdae6f35cf1d1b6ee2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga17465c32bf3733770826874668603d05"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__mailbox__apis.html#ga17465c32bf3733770826874668603d05">XPLMI_SHARED_MEM_SIZE</a>&#160;&#160;&#160;(160U)</td></tr>
<tr class="memdesc:ga17465c32bf3733770826874668603d05"><td class="mdescLeft">&#160;</td><td class="mdescRight">Max size of shared memory used to store the CDO command.  <a href="group__xilplmi__mailbox__apis.html#ga17465c32bf3733770826874668603d05">More...</a><br/></td></tr>
<tr class="separator:ga17465c32bf3733770826874668603d05"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga1cd29e5865f729668d2048de195cf33f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__mailbox__apis.html#ga1cd29e5865f729668d2048de195cf33f">XPlmi_ProcessMailbox</a> (XPlmi_ClientInstance *ClientPtr, u32 *MsgPtr, u32 MsgLen)</td></tr>
<tr class="memdesc:ga1cd29e5865f729668d2048de195cf33f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to the target module and gets the response from it.  <a href="group__xilplmi__mailbox__apis.html#ga1cd29e5865f729668d2048de195cf33f">More...</a><br/></td></tr>
<tr class="separator:ga1cd29e5865f729668d2048de195cf33f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaea4605770a6e4090bac10578131ca925"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__mailbox__apis.html#gaea4605770a6e4090bac10578131ca925">XPlmi_ClientInit</a> (XPlmi_ClientInstance *InstancePtr, XMailbox *MailboxPtr)</td></tr>
<tr class="memdesc:gaea4605770a6e4090bac10578131ca925"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the instance of mailbox.  <a href="group__xilplmi__mailbox__apis.html#gaea4605770a6e4090bac10578131ca925">More...</a><br/></td></tr>
<tr class="separator:gaea4605770a6e4090bac10578131ca925"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
